Documentation of script files in C# using Doxygen

This website contains a full documentation generated by Doxygen. To inspect C#-Files simply navigate to "Files" and open your target file. You can configure and update this documentation using the submodule "docs".

Generating documentation

After updating script files in C# in the master branch, it is recommended to update HTML documentation as well.

To do this, proceed as follows:

1. Install Graphviz 2.38 (http://www.graphviz.org/download/)
2. Install Doxygen 1.9.2 (https://www.doxygen.nl/download.html)
3. Open the file "ClassroomDoxyfile" in an editor of your choice.
4. Within this file, under the INPUT tag, you will find a listing of paths that contain the C# scripts to be documented. Modify these paths as needed. INPUT = ../Assets/ownScripts \ ../Assets/Scripts
5. Within this file, the path to the Graphviz program for graph display is specified under the DOT_PATH tag. Adjust this path as well if necessary. DOT_PATH = "C:\Program Files (x86)\Graphviz2.38\bin"
6. After you have saved the changes, you can close the editor.
7. Open the command prompt and change to the "Documentation" folder of the VR Classroom.
8. Regenerate the HTML documentation of the VR classroom by entering the command "doxygen KlassenzimmerDoxyfile". Once this process is finished, you can close the command prompt again.

Commenting source code

By commenting the source code, relevant information can be added to the documentation. However, in order for comments to be considered when generating Doxygen's documentation, they must follow certain guidelines. These guidelines can be found in detail in the Doxygen documentation at https://www.doxygen.nl/manual/docblocks.html.